Introduction et Paramètres pour Custom API

Le connecteur Custom API agit comme un Tout-en-Un (AIO) puisqu'il vous permet de vous connecter à n'importe quelle APIFerméInterface de Programmation Applicative (API).

Puisque chaque API est différente et nécessite donc des paramètres spécifiques, l'interface de ce connecteur est générique.

Pour définir une API, il vous suffit de téléverser le fichier du Profil API (extension .apip) et/ou les Tables (fichiers .rsd) et de spécifier les Propriétés (chaînes de connexion) en les ajoutant manuellement dans la section Autres propriétés de la connexion.

Authentifications

Les Authentifications sont liées et spécifiques aux API, vous devrez donc choisir parmi ces trois valeurs : Aucune, HTTP Basic, OAuth2.

Voici la liste des propriétés connues :

Nom de la propriété Définition Valeur Chaîne de Connexion Utilisé pour
ProfileSettings

Une liste de combinaisons nom-valeur séparées par des points-virgules, requises par la source de données que vous avez choisie.

Format : Key1=Value1;Key2=Value2

User

Password

Domain

 

 
ProfileSettings='User=< EmailId >;Password=< key >';'Other=Domain=< YourDomain >'
 Authentification définie sur HTTP Basic
Other

Dans la plupart des cas, elle est utilisée avec tous les fournisseurs d'API et est similaire à la propriété ProfileSettings.

Format : Key1=Value1;Key2=Value2

DefaultColumnSize: définit la longueur par défaut des champs de chaîne lorsque la Source de Données ne fournit pas la longueur de colonne dans les métadonnées. La valeur par défaut est 2000.

ConvertDateTimeToGMT : Détermine s'il faut convertir les valeurs de la date et de l'heure en GMT, à la place de l'heure locale de la machine.

RecordToFile: Enregistre le transfert de données de la socket sous-jacente vers le fichier spécifié.

 
DefaultColumnSize=< numeric value >

ConvertDateTimeToGMT=< true >

RecordToFile=< filename >
 Authentification définie sur Aucune, HTTP Basic ou OAuth2
OAuthClientId Le Client ID attribué lorsque vous enregistrez votre application auprès d'un serveur d'autorisation OAuth. Agit de la même façon que la valeur User 
OAuthClientId=< Unique Identifier key >
 Authentification définie sur OAuth2
OAuthClientSecret Le Client Secret attribué lorsque vous enregistrez votre application auprès d'un serveur d'autorisation OAuth . Agit de la même façon que la valeur Password 
OAuthClientSecret=< key >
 Authentification définie sur OAuth2
CallbackURL L'URL de rappel OAuth à utiliser lors de l'authentification. Cette valeur doit correspondre à l'URL de rappel que vous indiquez dans les paramètres de votre application. URL address 
CallBack URL=< Full URL Address >
 Authentification définie sur OAuth2
Scope Définit les actions spécifiques que les applications peuvent être autorisées à effectuer au nom d'un utilisateur. Forms 
Forms=< Read >
 Authentification définie sur OAuth2
Note

Pour personnaliser un Profil API, reportez-vous à Personnaliser votre API ou suivez la procédure décrite ci-dessous pour utiliser un profil API par défaut et ses tables connexes.

Paramètres pour Custom API

Pour configurer un Custom API :

  1. Dans la page des Connexions, cliquez sur Nouveau pour créer une nouvelle Connexion Source.
  2. Dans la liste, sélectionnez Custom API.
  3. Dans le champ Description, entrez un nom (de préférence lié à l'API à laquelle vous souhaitez vous connecter).
  4. Dans la liste déroulante Authentification, sélectionnez la méthode d'authentification utilisée pour l'API. Ici, nous sélectionnons Aucune car nous nous connectons à une API Web publique (c'est-à-dire, qu'aucun identifiant n'est requis pour afficher / récupérer les données de l'URL).
Note

Si vous sélectionnez HTTP Basic, reportez-vous à Authentification définie sur HTTP Basic pour continuer la configuration avec cette méthode d'authentification.

Si vous sélectionnez OAuth2, reportez-vous à Authentification définie sur OAuth2 pour continuer la configuration avec cette méthode d'authentification.

  1. Cliquez sur Téléverser pour naviguer jusqu'à l'emplacement où les Profils API sont stockés, sélectionnez l'un d'entre eux puis cliquez sur Ouvrir.
  2. Modifiez les autres paramètres (Type de Suivi etc.) selon vos préférences et cliquez sur Enregistrer pour terminer.
Authentification définie sur HTTP Basic

Si vous sélectionnez HTTP Basic comme méthode d'authentification :

  1. Cliquez sur Ajouter une propriété pour ajouter les propriétés et valeurs requises pour l'authentification de cette connexion à l'API.
  2. Cliquez sur Téléverser pour naviguer jusqu'à l'emplacement où les Profils API sont enregistrés, sélectionnez l'un d'entre eux puis cliquez sur Ouvrir.
  3. Modifiez les autres paramètres (Type de Suivi etc.) selon vos préférences et cliquez sur Enregistrer pour terminer.
Authentification définie sur OAuth2

Si vous sélectionnez OAuth2 comme méthode d'authentification :

  1. Renseignez les champs OAuthClientId et OAuthClientSecret situés sous la section Autres propriétés de la connexion.
  2. Cliquez sur Téléverser pour naviguer jusqu'à l'emplacement où les Profils API sont stockés, sélectionnez l'un d'entre eux puis cliquez sur Ouvrir.
  3. Modifiez les autres paramètres (Type de Suivi etc.) selon vos préférences et cliquez sur Enregistrer pour terminer.
Note

Comme présenté dans la capture d'écran ci-dessus, vous pouvez utiliser la section Autres Propriétés de la Connexion pour inclure des paramètres tels que la Clé API par le biais du nom de propriété ProfileSettings.

Nom de la propriété Valeur Chaîne de Connexion
ProfileSettings

API Key 

ProfileSettings='API Key'